class ITransactionManager(zope.interface.Interface):
'''An object that manages a sequence of transactions.
Applications use transaction managers to establish transaction boundaries.
'''
def begin():
'''Begin a new transaction.
If an existing transaction is in progress, it will be aborted.
The newTransaction() method of registered synchronizers is called,
passing the new transaction object.
'''
pass
def get():
'''Get the current transaction.
'''
pass
def commit():
'''Commit the current transaction.
'''
pass
def abort():
'''Abort the current transaction.
'''
pass
def savepoint(optimistic = False):
"""Create a savepoint from the current transaction.
If the optimistic argument is true, then data managers that
don't support savepoints can be used, but an error will be
raised if the savepoint is rolled back.
An ISavepoint object is returned.
"""
pass
def registerSynch(synch):
"""Register an ISynchronizer.
Synchronizers are notified about some major events in a transaction's
life. See ISynchronizer for details.
"""
pass
def unregisterSynch(synch):
"""Unregister an ISynchronizer.
Synchronizers are notified about some major events in a transaction's
life. See ISynchronizer for details.
"""
pass
class ITransaction(zope.interface.Interface):
'''Object representing a running transaction.
Objects with this interface may represent different transactions
during their lifetime (.begin() can be called to start a new
transaction using the same instance, although that example is
deprecated and will go away in ZODB 3.6).
'''
user = zope.interface.Attribute('A user name associated with the transaction.\n\n The format of the user name is defined by the application. The value\n is of Python type str. Storages record the user value, as meta-data,\n when a transaction commits.\n\n A storage may impose a limit on the size of the value; behavior is\n undefined if such a limit is exceeded (for example, a storage may\n raise an exception, or truncate the value).\n ')
description = zope.interface.Attribute('A textual description of the transaction.\n\n The value is of Python type str. Method note() is the intended\n way to set the value. Storages record the description, as meta-data,\n when a transaction commits.\n\n A storage may impose a limit on the size of the description; behavior\n is undefined if such a limit is exceeded (for example, a storage may\n raise an exception, or truncate the value).\n ')
def commit():
'''Finalize the transaction.
This executes the two-phase commit algorithm for all
IDataManager objects associated with the transaction.
'''
pass
def abort():
'''Abort the transaction.
This is called from the application. This can only be called
before the two-phase commit protocol has been started.
'''
pass
def savepoint(optimistic = False):
"""Create a savepoint.
If the optimistic argument is true, then data managers that don't
support savepoints can be used, but an error will be raised if the
savepoint is rolled back.
An ISavepoint object is returned.
"""
pass
def join(datamanager):
'''Add a data manager to the transaction.
`datamanager` must provide the transactions.interfaces.IDataManager
interface.
'''
pass
def note(text):
'''Add text to the transaction description.
This modifies the `.description` attribute; see its docs for more
detail. First surrounding whitespace is stripped from `text`. If
`.description` is currently an empty string, then the stripped text
becomes its value, else two newlines and the stripped text are
appended to `.description`.
'''
pass
def setUser(user_name, path = '/'):
'''Set the user name.
path should be provided if needed to further qualify the
identified user. This is a convenience method used by Zope.
It sets the .user attribute to str(path) + " " + str(user_name).
This sets the `.user` attribute; see its docs for more detail.
'''
pass
def setExtendedInfo(name, value):
'''Add extension data to the transaction.
name is the name of the extension property to set, of Python type
str; value must be picklable. Multiple calls may be made to set
multiple extension properties, provided the names are distinct.
Storages record the extension data, as meta-data, when a transaction
commits.
A storage may impose a limit on the size of extension data; behavior
is undefined if such a limit is exceeded (for example, a storage may
raise an exception, or remove `<name, value>` pairs).
'''Register a hook to call before the transaction is committed.
The specified hook function will be called after the transaction\'s
commit method has been called, but before the commit process has been
started. The hook will be passed the specified positional (`args`)
and keyword (`kws`) arguments. `args` is a sequence of positional
arguments to be passed, defaulting to an empty tuple (no positional
arguments are passed). `kws` is a dictionary of keyword argument
names and values to be passed, or the default None (no keyword
arguments are passed).
Multiple hooks can be registered and will be called in the order they
were registered (first registered, first called). This method can
also be called from a hook: an executing hook can register more
hooks. Applications should take care to avoid creating infinite loops
by recursively registering hooks.
Hooks are called only for a top-level commit. A subtransaction
commit or savepoint creation does not call any hooks. If the
transaction is aborted, hooks are not called, and are discarded.
Calling a hook "consumes" its registration too: hook registrations
do not persist across transactions. If it\'s desired to call the same
hook on every transaction commit, then addBeforeCommitHook() must be
called with that hook during every transaction; in such a case
consider registering a synchronizer object via a TransactionManager\'s
registerSynch() method instead.
'''
pass
def getBeforeCommitHooks():
'''Return iterable producing the registered addBeforeCommit hooks.
A triple (hook, args, kws) is produced for each registered hook.
The hooks are produced in the order in which they would be invoked
by a top-level transaction commit.
'''
pass
class ITransactionDeprecated(zope.interface.Interface):
'''Deprecated parts of the transaction API.'''
def begin(info = None):
'''Begin a new transaction.
If the transaction is in progress, it is aborted and a new
transaction is started using the same transaction object.
'''
pass
def register(object):
'''Register the given object for transaction control.'''
pass
class IDataManager(zope.interface.Interface):
"""Objects that manage transactional storage.
These objects may manage data for other objects, or they may manage
non-object storages, such as relational databases. For example,
a ZODB.Connection.
Note that when some data is modified, that data's data manager should
join a transaction so that data can be committed when the user commits
the transaction.
"""
transaction_manager = zope.interface.Attribute("The transaction manager (TM) used by this data manager.\n\n This is a public attribute, intended for read-only use. The value\n is an instance of ITransactionManager, typically set by the data\n manager's constructor.\n ")
def abort(transaction):
'''Abort a transaction and forget all changes.
Abort must be called outside of a two-phase commit.
Abort is called by the transaction manager to abort transactions
that are not yet in a two-phase commit.
'''
pass
def tpc_begin(transaction):
'''Begin commit of a transaction, starting the two-phase commit.
transaction is the ITransaction instance associated with the
transaction being committed.
'''
pass
def commit(transaction):
'''Commit modifications to registered objects.
Save changes to be made persistent if the transaction commits (if
tpc_finish is called later). If tpc_abort is called later, changes
must not persist.
This includes conflict detection and handling. If no conflicts or
errors occur, the data manager should be prepared to make the
changes persist when tpc_finish is called.
'''
pass
def tpc_vote(transaction):
"""Verify that a data manager can commit the transaction.
This is the last chance for a data manager to vote 'no'. A
data manager votes 'no' by raising an exception.
transaction is the ITransaction instance associated with the
transaction being committed.
"""
pass
def tpc_finish(transaction):
"""Indicate confirmation that the transaction is done.
Make all changes to objects modified by this transaction persist.
transaction is the ITransaction instance associated with the
transaction being committed.
This should never fail. If this raises an exception, the
database is not expected to maintain consistency; it's a
serious error.
"""
pass
def tpc_abort(transaction):
'''Abort a transaction.
This is called by a transaction manager to end a two-phase commit on
the data manager. Abandon all changes to objects modified by this
transaction.
transaction is the ITransaction instance associated with the
transaction being committed.
This should never fail.
'''
pass
def sortKey():
'''Return a key to use for ordering registered DataManagers.
ZODB uses a global sort order to prevent deadlock when it commits
transactions involving multiple resource managers. The resource
manager must define a sortKey() method that provides a global ordering
for resource managers.
'''
pass
class ISavepointDataManager(IDataManager):
def savepoint():
'''Return a data-manager savepoint (IDataManagerSavepoint).
'''
pass
class IDataManagerSavepoint(zope.interface.Interface):
"""Savepoint for data-manager changes for use in transaction savepoints.
Datamanager savepoints are used by, and only by, transaction savepoints.
Note that data manager savepoints don't have any notion of, or
responsibility for, validity. It isn't the responsibility of
data-manager savepoints to prevent multiple rollbacks or rollbacks after
transaction termination. Preventing invalid savepoint rollback is the
responsibility of transaction rollbacks. Application code should never
use data-manager savepoints.
"""
def rollback():
'''Rollback any work done since the savepoint.
'''
pass
class ISavepoint(zope.interface.Interface):
'''A transaction savepoint.
'''
def rollback():
"""Rollback any work done since the savepoint.
InvalidSavepointRollbackError is raised if the savepoint isn't valid.
"""
pass
valid = zope.interface.Attribute('Boolean indicating whether the savepoint is valid')
class InvalidSavepointRollbackError(Exception):
'''Attempt to rollback an invalid savepoint.
A savepoint may be invalid because:
- The surrounding transaction has committed or aborted.
- An earlier savepoint in the same transaction has been rolled back.
'''
pass
class ISynchronizer(zope.interface.Interface):
'''Objects that participate in the transaction-boundary notification API.
'''
def beforeCompletion(transaction):
'''Hook that is called by the transaction at the start of a commit.
'''
pass
def afterCompletion(transaction):
'''Hook that is called by the transaction after completing a commit.
'''
pass
def newTransaction(transaction):
"""Hook that is called at the start of a transaction.
This hook is called when, and only when, a transaction manager's
(.txt)